oracle.AWXML
Class OlapMeasureInput

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.OlapMeasureInput

public class OlapMeasureInput

extends BaseObject

An object that provides an input for the OLAP operation of an OlapMeasure. The type of OLAP operation is specified by the OLAP operator of the OlapMeasure. Every OLAP operation requires a Measure that provides the values upon which the operation is based and a time Dimension. Some operations require Hierarchy or Level objects or scalar or other values. The objects or values are provided by OlapMeasureInput objects.

An OlapMeasureInput has an input object and a keyword that identifies the type of the input. An input object is a BaseObject or a String that contains a scalar or other value for the operation. Each input is represented by a separate OlapMeasureInput.

For a table of OLAP operator values and the OlapMeasureInput keywords, objects, and values required by the operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values.

See Also:

OlapMeasure

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

OlapMeasureInput(BaseObject input)
Creates an OlapMeasureInput for the specified OlapMeasure.

Method Summary

java.lang.String	getKeyWord() Gets the keyword that identifies the type of input specified by the OlapMeasureInput.
BaseObject	getReferencedObj() Gets the BaseObject that is the input specified by the OlapMeasureInput.
java.lang.String	getScalarValue() Gets the scalar or other value that is the input specified by the OlapMeasureInput.
void	setKeyWord(java.lang.String input) Specifies a keyword that identifies the type of input for the OlapMeasureInput.
void	setReferencedObj(BaseObject input) Specifies a BaseObject that is referenced by the OLAP operation that produces the values of an OlapMeasure.
void	setScalarValue(java.lang.String input) Specifies a scalar or other value that is an input to an OlapMeasure operation.
java.lang.String	WriteToXML() Gets an XML representation of the OlapMeasureInput.

Methods inherited from class oracle.AWXML.BaseObject

Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OlapMeasureInput

public OlapMeasureInput(BaseObject input)

Creates an OlapMeasureInput for the specified OlapMeasure. An application should create an OlapMeasureIput by using the createOlapMeasureInput method of an OlapMeasure.

Parameters:

input - The OlapMeasure to own the OlapMeasureInput.

Method Detail

setKeyWord

public void setKeyWord(java.lang.String input)

Specifies a keyword that identifies the type of input for the OlapMeasureInput. For a table that contains the keywords and the objects or values required as inputs by the various OLAP operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values.

Parameters:

input - A String that specifies a keyword that identifies the type of input for the OLAP operation.

getKeyWord

public java.lang.String getKeyWord()

Gets the keyword that identifies the type of input specified by the OlapMeasureInput.

Returns:

A String that contains the keyword.

getScalarValue

public java.lang.String getScalarValue()

Gets the scalar or other value that is the input specified by the OlapMeasureInput.

Returns:

A String that contains the scalar or other value.

setScalarValue

public void setScalarValue(java.lang.String input)

Specifies a scalar or other value that is an input to an OlapMeasure operation. For a table that contains the keywords and the objects or values required as inputs by the various OLAP operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values.

Parameters:

input - A String that contains a scalar or other value.

setReferencedObj

public void setReferencedObj(BaseObject input)

Specifies a BaseObject that is referenced by the OLAP operation that produces the values of an OlapMeasure. For a table that contains the keywords and the objects or values required as inputs by the various OLAP operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values.

Parameters:

input - The BaseObject that is the input for the OLAP operation.

getReferencedObj

public BaseObject getReferencedObj()

Gets the BaseObject that is the input specified by the OlapMeasureInput.

Returns:

The BaseObject that is an input to the OLAP operation that produces the values of an OlapMeasure.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the OlapMeasureInput.

Overrides:

WriteToXML in class BaseObject

Returns:

An XML String that represents the OlapMeasureInput.